MyCompany のテクニカルライティングガイドライン

このページは、以下に示す概要トピックテンプレートに基づいています。他に同様のトピックを作成する場合は、このテンプレートを使用します。

 

テクニカルライティング部門では、社内の他の部門の意見も取り入れてこのガイドを作成および保守しています。このガイドの目的は、主に MyCompany の外部用ドキュメント(ユーザガイド、オンラインヘルプ、Web コンテンツ)の標準規格を定めることですが、テクニカルライティング部門に情報を提供するユーザをサポートすることも目的にしています。

 

このガイドは、ソフトウェア開発者、QA エンジニア、請負業者、マーケティング部門、トレーニング部門など、MyCompany のスタイルガイドラインが必要なすべてのユーザが対象です。

 

 

 


概要トピック

概要トピックでは、一般的な概念について記述します。このトピックでは、「全体像」を示します。例えば、ポリシーおよび手順ガイド、オンラインマニュアル、部門ガイドラインまたはその他特定のコンポーネントについてユーザに概要を示す「ようこそ」トピックは概要トピックに当たります。通常、このトピックは節または章の先頭に配置します。概要トピックには、後続の情報の説明、後続の情報の使用方法、安全上の警告または注意、参考資料などを含めることができます。多くの場合、概要トピックには、決定/ナビゲーショントピックの先頭節よりも詳細な情報が含まれます。概要トピックから決定/ナビゲーショントピックにリンクし、そこからさらに作業トピックにリンクすることが一般的です。この構造によって、ユーザを一般的な情報からより具体的な情報へと導くことができます。

 

 

..... の概要

このスペースを使用して、概要トピックの内容を記述します。